<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>PaleGem: IEventManager Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">PaleGem
   &#160;<span id="projectnumber">0.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_i_event_manager-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">IEventManager Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Manages events and listeners.  
 <a href="class_i_event_manager.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_i_event_manager_8h_source.html">IEventManager.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for IEventManager:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_i_event_manager.png" usemap="#IEventManager_map" alt=""/>
  <map id="IEventManager_map" name="IEventManager_map">
<area href="classpg_input_event_manager.html" title="PaleGem&#39;s keyboard event manager." alt="pgInputEventManager" shape="rect" coords="0,56,136,80"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6f0594c36436cef0ec2f1a292e696a3c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_event_manager.html#a6f0594c36436cef0ec2f1a292e696a3c">~IEventManager</a> ()</td></tr>
<tr class="separator:a6f0594c36436cef0ec2f1a292e696a3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71e4cf7f0b61929a3f878e0d09778d9b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_event_manager.html#a71e4cf7f0b61929a3f878e0d09778d9b">Update</a> (float frameTime)=0</td></tr>
<tr class="memdesc:a71e4cf7f0b61929a3f878e0d09778d9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the event manager.  <a href="#a71e4cf7f0b61929a3f878e0d09778d9b">More...</a><br/></td></tr>
<tr class="separator:a71e4cf7f0b61929a3f878e0d09778d9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bc99cb0ef622ba2ec2ab0e1f2ca16c9"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_event_manager.html#a4bc99cb0ef622ba2ec2ab0e1f2ca16c9">RegisterListener</a> (<a class="el" href="class_i_event_listener.html">IEventListener</a> *listener, <a class="el" href="_i_event_manager_8h.html#ab13f1eb4f7990ad6a97263126b1e8565">EVENT_CLASS</a> eventClass=<a class="el" href="_i_event_manager_8h.html#ab13f1eb4f7990ad6a97263126b1e8565a230d22d3c096db888df52a0e5d5ba7ac">EC_UNKNOWN</a>, <a class="el" href="_i_event_manager_8h.html#acebeb2e728025f3444b405355a3f8e92">EVENT_NAME</a> eventName=<a class="el" href="_i_event_manager_8h.html#acebeb2e728025f3444b405355a3f8e92a0bdce79d948b8215713bcf669df0b8f1">E_UNKNOWN</a>)=0</td></tr>
<tr class="memdesc:a4bc99cb0ef622ba2ec2ab0e1f2ca16c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers an object to receive all events.  <a href="#a4bc99cb0ef622ba2ec2ab0e1f2ca16c9">More...</a><br/></td></tr>
<tr class="separator:a4bc99cb0ef622ba2ec2ab0e1f2ca16c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e6327650d496ce27637550bc46d808b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_event_manager.html#a5e6327650d496ce27637550bc46d808b">UnregisterListener</a> (<a class="el" href="class_i_event_listener.html">IEventListener</a> *listener)=0</td></tr>
<tr class="memdesc:a5e6327650d496ce27637550bc46d808b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregisters an object.  <a href="#a5e6327650d496ce27637550bc46d808b">More...</a><br/></td></tr>
<tr class="separator:a5e6327650d496ce27637550bc46d808b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a392a23f11ab77aa893cbef5bd4cd6fa8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_event_manager.html#a392a23f11ab77aa893cbef5bd4cd6fa8">RegisterEvent</a> (int eventName, int eventClass, <a class="el" href="struct_i_event_data.html">IEventData</a> *pData=NULL)=0</td></tr>
<tr class="memdesc:a392a23f11ab77aa893cbef5bd4cd6fa8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Queues an event that is then received by the obj that registered for it.  <a href="#a392a23f11ab77aa893cbef5bd4cd6fa8">More...</a><br/></td></tr>
<tr class="separator:a392a23f11ab77aa893cbef5bd4cd6fa8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5e47321003d80135281a90034c7064e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_event_manager.html#aa5e47321003d80135281a90034c7064e">ShutDown</a> ()=0</td></tr>
<tr class="memdesc:aa5e47321003d80135281a90034c7064e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shuts down the event manager, frees leftover events and listeners, deallocates memory.  <a href="#aa5e47321003d80135281a90034c7064e">More...</a><br/></td></tr>
<tr class="separator:aa5e47321003d80135281a90034c7064e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Manages events and listeners. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a6f0594c36436cef0ec2f1a292e696a3c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual IEventManager::~IEventManager </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a392a23f11ab77aa893cbef5bd4cd6fa8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void IEventManager::RegisterEvent </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>eventName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>eventClass</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_i_event_data.html">IEventData</a> *&#160;</td>
          <td class="paramname"><em>pData</em> = <code>NULL</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Queues an event that is then received by the obj that registered for it. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">eventName</td><td>The name of the event that is to be registered </td></tr>
    <tr><td class="paramname">eventClass</td><td>The classes to which the event applies </td></tr>
    <tr><td class="paramname">data</td><td>Additional data the event wants to send to the listeners, must be derived from <a class="el" href="struct_i_event_data.html" title="Data structure that can be used to send data with events.">IEventData</a> </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classpg_input_event_manager.html#a4e5414722dc173201669de70df67352f">pgInputEventManager</a>.</p>

</div>
</div>
<a class="anchor" id="a4bc99cb0ef622ba2ec2ab0e1f2ca16c9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void IEventManager::RegisterListener </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_i_event_listener.html">IEventListener</a> *&#160;</td>
          <td class="paramname"><em>listener</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_i_event_manager_8h.html#ab13f1eb4f7990ad6a97263126b1e8565">EVENT_CLASS</a>&#160;</td>
          <td class="paramname"><em>eventClass</em> = <code><a class="el" href="_i_event_manager_8h.html#ab13f1eb4f7990ad6a97263126b1e8565a230d22d3c096db888df52a0e5d5ba7ac">EC_UNKNOWN</a></code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_i_event_manager_8h.html#acebeb2e728025f3444b405355a3f8e92">EVENT_NAME</a>&#160;</td>
          <td class="paramname"><em>eventName</em> = <code><a class="el" href="_i_event_manager_8h.html#acebeb2e728025f3444b405355a3f8e92a0bdce79d948b8215713bcf669df0b8f1">E_UNKNOWN</a></code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Registers an object to receive all events. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">listener</td><td>The object that wants to be registered, must be derived from <a class="el" href="class_i_event_listener.html" title="Holds the OnEvent function.">IEventListener</a> </td></tr>
    <tr><td class="paramname">eventClass</td><td>The event class the object want's to register for, use EC_UNKNOWN for all events </td></tr>
    <tr><td class="paramname">eventName</td><td>The event name the object wants to register for, use E_UNKNOWN to receive all events </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classpg_input_event_manager.html#a9fc9092074b92baba1566c3e51ddbaad">pgInputEventManager</a>.</p>

</div>
</div>
<a class="anchor" id="aa5e47321003d80135281a90034c7064e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void IEventManager::ShutDown </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Shuts down the event manager, frees leftover events and listeners, deallocates memory. </p>

<p>Implemented in <a class="el" href="classpg_input_event_manager.html#add5f4d0acf0970c5963dcd5c7e7275b5">pgInputEventManager</a>.</p>

</div>
</div>
<a class="anchor" id="a5e6327650d496ce27637550bc46d808b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void IEventManager::UnregisterListener </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_i_event_listener.html">IEventListener</a> *&#160;</td>
          <td class="paramname"><em>listener</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Unregisters an object. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">listener</td><td>The object that wants to be unregistered, must be derived from <a class="el" href="class_i_event_listener.html" title="Holds the OnEvent function.">IEventListener</a> </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classpg_input_event_manager.html#ae404352163a7bda1b7392a95600f7eda">pgInputEventManager</a>.</p>

</div>
</div>
<a class="anchor" id="a71e4cf7f0b61929a3f878e0d09778d9b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void IEventManager::Update </td>
          <td>(</td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>frameTime</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Updates the event manager. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">frameTime</td><td>Delta time of two frames </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classpg_input_event_manager.html#a451a5000cde52f87fdfd7c81fbfb9540">pgInputEventManager</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Inc/<a class="el" href="_i_event_manager_8h_source.html">IEventManager.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 1 2013 11:55:07 for PaleGem by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
